home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / u_man / cat3 / Tcl / tclvars.z / tclvars
Encoding:
Text File  |  1998-10-30  |  11.2 KB  |  199 lines
  1.  
  2.  
  3.  
  4. ttttccccllllvvvvaaaarrrrssss((((3333TTTTccccllll))))                                                    ttttccccllllvvvvaaaarrrrssss((((3333TTTTccccllll))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      tclvars - Variables used by Tcl
  10.  
  11.  
  12. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  13.      The following global variables are created and managed automatically by
  14.      the Tcl library.  Except where noted below, these variables should
  15.      normally be treated as read-only by application-specific code and by
  16.      users.
  17.  
  18.      eeeennnnvvvv
  19.           This variable is maintained by Tcl as an array whose elements are
  20.           the environment variables for the process.  Reading an element will
  21.           return the value of the corresponding environment variable.  Setting
  22.           an element of the array will modify the corresponding environment
  23.           variable or create a new one if it doesn't already exist.  Unsetting
  24.           an element of eeeennnnvvvv will remove the corresponding environment
  25.           variable.  Changes to the eeeennnnvvvv array will affect the environment
  26.           passed to children by commands like eeeexxxxeeeecccc.  If the entire eeeennnnvvvv array
  27.           is unset then Tcl will stop monitoring eeeennnnvvvv accesses and will not
  28.           update environment variables.
  29.  
  30.      eeeerrrrrrrroooorrrrCCCCooooddddeeee
  31.           After an error has occurred, this variable will be set to hold
  32.           additional information about the error in a form that is easy to
  33.           process with programs.  eeeerrrrrrrroooorrrrCCCCooooddddeeee consists of a Tcl list with one or
  34.           more elements.  The first element of the list identifies a general
  35.           class of errors, and determines the format of the rest of the list.
  36.           The following formats for eeeerrrrrrrroooorrrrCCCCooooddddeeee are used by the Tcl core;
  37.           individual applications may define additional formats.
  38.  
  39.           AAAARRRRIIIITTTTHHHH _c_o_d_e _m_s_g
  40.                This format is used when an arithmetic error occurs (e.g. an   |
  41.                attempt to divide by zero in the eeeexxxxpppprrrr command).  _C_o_d_e          |
  42.                identifies the precise error and _m_s_g provides a human-readable |
  43.                description of the error.  _C_o_d_e will be either DIVZERO (for an |
  44.                attempt to divide by zero), DOMAIN (if an argument is outside  |
  45.                the domain of a function, such as acos(-3)), IOVERFLOW (for    |
  46.                integer overflow), OVERFLOW (for a floating-point overflow), or|
  47.                UNKNOWN (if the cause of the error cannot be determined).
  48.  
  49.           CCCCHHHHIIIILLLLDDDDKKKKIIIILLLLLLLLEEEEDDDD _p_i_d _s_i_g_N_a_m_e _m_s_g
  50.                This format is used when a child process has been killed
  51.                because of a signal.  The second element of eeeerrrrrrrroooorrrrCCCCooooddddeeee will be
  52.                the process's identifier (in decimal).  The third element will
  53.                be the symbolic name of the signal that caused the process to
  54.                terminate; it will be one of the names from the include file
  55.                signal.h, such as SSSSIIIIGGGGPPPPIIIIPPPPEEEE.  The fourth element will be a short
  56.                human-readable message describing the signal, such as ``write
  57.                on pipe with no readers'' for SSSSIIIIGGGGPPPPIIIIPPPPEEEE.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ttttccccllllvvvvaaaarrrrssss((((3333TTTTccccllll))))                                                    ttttccccllllvvvvaaaarrrrssss((((3333TTTTccccllll))))
  71.  
  72.  
  73.  
  74.           CCCCHHHHIIIILLLLDDDDSSSSTTTTAAAATTTTUUUUSSSS _p_i_d _c_o_d_e
  75.                This format is used when a child process has exited with a
  76.                non-zero exit status.  The second element of eeeerrrrrrrroooorrrrCCCCooooddddeeee will be
  77.                the process's identifier (in decimal) and the third element
  78.                will be the exit code returned by the process (also in
  79.                decimal).
  80.  
  81.           CCCCHHHHIIIILLLLDDDDSSSSUUUUSSSSPPPP _p_i_d _s_i_g_N_a_m_e _m_s_g
  82.                This format is used when a child process has been suspended
  83.                because of a signal.  The second element of eeeerrrrrrrroooorrrrCCCCooooddddeeee will be
  84.                the process's identifier, in decimal.  The third element will
  85.                be the symbolic name of the signal that caused the process to
  86.                suspend; this will be one of the names from the include file
  87.                signal.h, such as SSSSIIIIGGGGTTTTTTTTIIIINNNN.  The fourth element will be a short
  88.                human-readable message describing the signal, such as
  89.                ``background tty read'' for SSSSIIIIGGGGTTTTTTTTIIIINNNN.
  90.  
  91.           NNNNOOOONNNNEEEE
  92.                This format is used for errors where no additional information
  93.                is available for an error besides the message returned with the
  94.                error.  In these cases eeeerrrrrrrroooorrrrCCCCooooddddeeee will consist of a list
  95.                containing a single element whose contents are NNNNOOOONNNNEEEE.
  96.  
  97.           PPPPOOOOSSSSIIIIXXXX _e_r_r_N_a_m_e _m_s_g
  98.                If the first element of eeeerrrrrrrroooorrrrCCCCooooddddeeee is PPPPOOOOSSSSIIIIXXXX, then the error     |
  99.                occurred during a POSIX kernel call.  The second element of the
  100.                list will contain the symbolic name of the error that occurred,
  101.                such as EEEENNNNOOOOEEEENNNNTTTT; this will be one of the values defined in the
  102.                include file errno.h.  The third element of the list will be a
  103.                human-readable message corresponding to _e_r_r_N_a_m_e, such as ``no
  104.                such file or directory'' for the EEEENNNNOOOOEEEENNNNTTTT case.
  105.  
  106.           To set eeeerrrrrrrroooorrrrCCCCooooddddeeee, applications should use library procedures such as
  107.           TTTTccccllll____SSSSeeeettttEEEErrrrrrrroooorrrrCCCCooooddddeeee and TTTTccccllll____PPPPoooossssiiiixxxxEEEErrrrrrrroooorrrr, or they may invoke the eeeerrrrrrrroooorrrr   |
  108.           command.  If one of these methods hasn't been used, then the Tcl
  109.           interpreter will reset the variable to NNNNOOOONNNNEEEE after the next error.
  110.  
  111.      eeeerrrrrrrroooorrrrIIIInnnnffffoooo
  112.           After an error has occurred, this string will contain one or more
  113.           lines identifying the Tcl commands and procedures that were being
  114.           executed when the most recent error occurred.  Its contents take the
  115.           form of a stack trace showing the various nested Tcl commands that
  116.           had been invoked at the time of the error.
  117.  
  118.      ttttccccllll____lllliiiibbbbrrrraaaarrrryyyy
  119.           When an interpreter is created, Tcl initializes this variable to    |
  120.           hold the name of a directory containing the system library of Tcl   |
  121.           scripts, such as those used for auto-loading.  See the lllliiiibbbbrrrraaaarrrryyyy      |
  122.           manual entry for details of the facilities provided by the Tcl      |
  123.           script library.  Normally each application will have its own        |
  124.           application-specific script library in addition to the Tcl script   |
  125.           library; each application should set a global variable with a name  |
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. ttttccccllllvvvvaaaarrrrssss((((3333TTTTccccllll))))                                                    ttttccccllllvvvvaaaarrrrssss((((3333TTTTccccllll))))
  137.  
  138.  
  139.  
  140.           like $$$$_a_p_p____lllliiiibbbbrrrraaaarrrryyyy (where _a_p_p is the application's name) to hold the |
  141.           location of that application's library directory.  The initial value|
  142.           of ttttccccllll____lllliiiibbbbrrrraaaarrrryyyy is set from the TCL_LIBRARY environment variable if  |
  143.           one exists, or from a compiled-in value otherwise.  A Tcl           |
  144.           application may change this variable to use a different library     |
  145.           directory.  The value of this variable is returned by the iiiinnnnffffoooo      |
  146.           lllliiiibbbbrrrraaaarrrryyyy command.
  147.  
  148.      ttttccccllll____ppppaaaattttcccchhhhLLLLeeeevvvveeeellll
  149.           When an interpreter is created Tcl initializes this variable to hold|
  150.           a string giving the current patch level for Tcl, such as 7777....3333pppp2222 for  |
  151.           Tcl 7.3 with the first two official patches, or 7777....4444bbbb4444 for the fourth|
  152.           beta release of Tcl 7.4.  The value of this variable is returned by |
  153.           the iiiinnnnffffoooo ppppaaaattttcccchhhhlllleeeevvvveeeellll command.
  154.  
  155.      ttttccccllll____pppprrrreeeecccciiiissssiiiioooonnnn
  156.           If this variable is set, it must contain a decimal number giving the|
  157.           number of significant digits to include when converting floating-   |
  158.           point values to strings.  If this variable is not set then 6 digits |
  159.           are included.  17 digits is ``perfect'' for IEEE floating-point in  |
  160.           that it allows double-precision values to be converted to strings   |
  161.           and back to binary with no loss of precision.
  162.  
  163.      ttttccccllll____vvvveeeerrrrssssiiiioooonnnn
  164.           When an interpreter is created Tcl initializes this variable to hold|
  165.           the version number for this version of Tcl in the form _x._y.  Changes|
  166.           to _x represent major changes with probable incompatibilities and    |
  167.           changes to _y represent small enhancements and bug fixes that retain |
  168.           backward compatibility.  The value of this variable is returned by  |
  169.           the iiiinnnnffffoooo ttttccccllllvvvveeeerrrrssssiiiioooonnnn command.
  170.  
  171.  
  172. KKKKEEEEYYYYWWWWOOOORRRRDDDDSSSS
  173.      arithmetic, error, environment, POSIX, precision, subprocess, variables
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.